/**
 * Copyright (c) 2009 Jim Hurne
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package org.tzconverter.menu;

import java.awt.event.ActionListener;
import java.awt.event.ItemListener;

/**
 * View component of the application menu.
 * 
 * 
 * @since Jun 20, 2009
 */

public interface MenuView
{ 
  /**
   * Sets the state of the given menu item. The menu item
   * must be a check-box menu item.
   * 
   * @param menuItem
   * @param checkBoxMenuState
   */
  public void setState(Item menuItem, boolean checkBoxMenuState);
  
  /**
   * Gets the current state of the givem menu item.  The menu item
   * must be a check-box menu item.
   * 
   * @param menuItem
   * @return
   */
  public boolean getState(Item menuItem);
 
  /**
   * Sets the enabled property of the given menu item.
   * 
   * @param menuItem
   * @param enabled
   */
  public void setEnabled(Item menuItem, boolean enabled);
  
  /**
   * Adds an action listener to the given menu item.
   * 
   * @param menuItem
   * @param listener
   */
  public void addActionListener(Item menuItem, ActionListener listener);
  
  /**
   * Removes the given action listner from the given menu item.
   * 
   * @param menuItem
   * @param listener
   */
  public void removeActionListener(Item menuItem, ActionListener listener);
  
  /**
   * Adds the given item listener to the given menu item.
   * 
   * @param menuItem
   * @param listener
   */
  public void addItemListener(Item menuItem, ItemListener listener);
  
  
  /**
   * Removes the given item listener from the given menu item.
   * 
   * @param menuItem
   * @param listener
   */
  public void removeItemListener(Item menuItem, ItemListener listener);  
}
